Deprecate gdk_visual_get_byte_order
authorMatthias Clasen <mclasen@redhat.com>
Sat, 26 Mar 2016 19:06:10 +0000 (15:06 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Sat, 26 Mar 2016 19:07:09 +0000 (15:07 -0400)
This function is only useful when working with XImages,
and is not meaningfully implemented in other backends.

gdk/gdkvisual.c
gdk/gdkvisual.h

index e3c5b6f9c1a24d8e6b7f2a19660ab628f63792b9..82305fc90afd6ff50033724a01c3e72225c29c83 100644 (file)
@@ -302,10 +302,15 @@ gdk_visual_get_depth (GdkVisual *visual)
  * @visual: A #GdkVisual.
  *
  * Returns the byte order of this visual.
+ * The information returned by this function is only relevant
+ * when working with XImages, and not all backends return
+ * meaningful information for this.
  *
  * Returns: A #GdkByteOrder stating the byte order of @visual.
  *
  * Since: 2.22
+ *
+ * Deprecated: 3.22: This information is not useful
  */
 GdkByteOrder
 gdk_visual_get_byte_order (GdkVisual *visual)
@@ -344,7 +349,8 @@ gdk_visual_get_colormap_size (GdkVisual *visual)
  *
  * Since: 2.22
  *
- * Deprecated: 3.22. Use gdk_visual_get_red_pixel_details() and its variants
+ * Deprecated: 3.22. Use gdk_visual_get_red_pixel_details() and its variants to
+ *     learn about the pixel layout of TrueColor and DirectColor visuals
  */
 gint
 gdk_visual_get_bits_per_rgb (GdkVisual *visual)
index 3f603a3989d6ea32493814c28c9a3289cc05d8a2..84337aaddc0cb7d5fe77517e20f896e719f41d5e 100644 (file)
@@ -115,7 +115,7 @@ GDK_AVAILABLE_IN_ALL
 GdkVisualType gdk_visual_get_visual_type         (GdkVisual *visual);
 GDK_AVAILABLE_IN_ALL
 gint          gdk_visual_get_depth               (GdkVisual *visual);
-GDK_AVAILABLE_IN_ALL
+GDK_DEPRECATED_IN_3_22
 GdkByteOrder  gdk_visual_get_byte_order          (GdkVisual *visual);
 GDK_AVAILABLE_IN_ALL
 gint          gdk_visual_get_colormap_size       (GdkVisual *visual);